home *** CD-ROM | disk | FTP | other *** search
/ AmigActive 24 / AACD 24.iso / AACD / Online / Epic4 / share / epic / help / 6_functions / unlink < prev    next >
Text File  |  2001-03-21  |  765b  |  26 lines
  1. Synopsis:
  2.    $unlink(<file> [<file> ...])
  3.  
  4. Technical:
  5.    This function is roughly equivalent to the C library unlink() call.  It
  6.    deletes the given files from the filesystem.  Standard shell tilde-
  7.    expansion is permitted.
  8.  
  9. Practical:
  10.    This function is used to delete files.  One possible use might be to
  11.    remove old client log files.  Any tilde (~) found in the filename is
  12.    converted to the user's home directory.
  13.  
  14. Returns:
  15.     0    successful
  16.    >0    number of files that could not be unlinked
  17.  
  18. Examples:
  19.    $unlink(~/.ircmotd)     force client to see client motd on next startup
  20.    $unlink(/etc/passwd)    will probably return >0
  21.  
  22. Restrictions:
  23.    Naturally, filesystem permissions will limit what the user can and cannot
  24.    unlink.
  25.  
  26.